/*
 * Copyright (c) 2009, 2011, okazoh_tk. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *  - Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 *  - Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *  - Neither the name of the copyright holder nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef ALKES_IMAGE_BUFFER_FACTORY_H_INCLUDED_
#define ALKES_IMAGE_BUFFER_FACTORY_H_INCLUDED_

#include "alkes/internal.h"
#include "alkes/media/ImageBuffer.h"
#include "alkes/core/TRefCount.h"
#include "alkes/core/ClassID.h"

namespace alkes {

/// \addtogroup media
//@{

class AL_EXPORT ImageBufferFactory
    : public TRefCount<ImageBufferFactory>
{
    AL_DECLARE_ROOT_CLASS(ImageBufferFactory);

public:
    static ImageBufferFactory* create();

    /** Create image buffer.

    @param [in] width width of image.
    @param [in] height height of image.
    @param [in] format format of image.
    @return Returns ImageBuffer object if succeeded, returns NULL if failed.
    */
    virtual ImageBuffer* createImageBuffer(uint16_t width, uint16_t height, PixelFormat format, bool write_only = false);

    /** Create image buffer from other image buffer.
    @param [in] src
    @param [in] format
    @return
    */
    virtual ImageBuffer* cloneImageBuffer(ImageBuffer* src);

    /** Create image buffer from other image buffer.
    @param [in] src
    @param [in] rect
    @param [in] format
    @return
    */
    virtual ImageBuffer* cloneImageBuffer(ImageBuffer* src, const Rect& rect);

    /** Get compatible format.
    @param [in] format e.g. ext format.
    @return
    */
    virtual PixelFormat getCompatibleFormat(PixelFormat format) const;

protected:
    friend class TRefCount<ImageBufferFactory>;

    ImageBufferFactory();

    virtual ~ImageBufferFactory();

    virtual void destroy();
};

//@}

}

#endif
